home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_200 / 260_01 / rz.1 < prev    next >
Text File  |  1988-02-23  |  7KB  |  278 lines
  1. '\" Revision Level 
  2. '\" Last Delta     01-15-87
  3. .TH RZ 1 OMEN
  4. .SH NAME
  5. rb, rz \- XMODEM, YMODEM, ZMODEM (Batch) file receive
  6. .SH SYNOPSIS
  7. .B rz
  8. .RB [\- "\ +1abpqtuv" ]
  9. .br
  10. .B rb
  11. .RB [\- "\ +1abqtuv" ]
  12. .br
  13. .B rz
  14. .RB [\- "\ 1abcqtuv" ]
  15. .I file
  16. .br
  17. .B gz
  18. .I "file ..."
  19. .br
  20. .RB [ \- ][ v ] rzCOMMAND
  21. .SH DESCRIPTION
  22. This program uses error correcting protocol to receive
  23. files over a serial port from a variety of programs running under
  24. PC-DOS, CP/M,
  25. .SM Unix,
  26. and other operating systems.
  27.  
  28. The first form of
  29. .I rz
  30. (Receive ZMODEM)
  31. receives files with the ZMODEM batch protocol.
  32. If the sending program does not support ZMODEM,
  33. .I rz
  34. steps down to YMODEM protocol
  35. after 50 seconds.
  36. This delay can be eliminated by calling the program as
  37. .I rb .
  38.  
  39. When receiving with XMODEM or YMODEM,
  40. .I Rz
  41. accepts either standard 128 byte sectors or
  42. 1024 byte sectors
  43. (YAM
  44. .B -k
  45. option).
  46. The user should determine when
  47. the longer block length
  48. actually improves throughput without causing problems.
  49.  
  50. If extended file information (file length, etc.)
  51. is received,
  52. the file length controls the number of bytes written to
  53. the output dataset (YMODEM only),
  54. and the modify time and file mode
  55. (iff non zero)
  56. are set accordingly.
  57.  
  58. If no extended file information is received,
  59. slashes in the pathname are changed to underscore,
  60. and any trailing period in the pathname is eliminated.
  61. This conversion is useful for files received from CP/M systems.
  62. With YMODEM, each file name is converted to lower case
  63. unless it contains one or more lower case letters.
  64.  
  65.  
  66. The second form of
  67. .I rz
  68. receives a single
  69. .I file
  70. with XMODEM protocol.
  71. The user must supply the file name to both sending and receiving programs.
  72.  
  73. .I Gz
  74. is a shell script which calls
  75. .I sz
  76. to command a Pro-YAM or compatible program to transmit the specified files.
  77. Pathnames used with
  78. .I gz
  79. must be escaped if they have special significance to the Unix shell.
  80. .br
  81. EXAMPLE:
  82. gz "-1 C:*.c D:*.h"
  83.  
  84.  
  85. The third form of
  86. .I rz
  87. is invoked as
  88. .B rzCOMMAND
  89. (with an optional leading \- as generated by login(1)).
  90. For each received file,
  91. rz will pipe the file to ``COMMAND filename''
  92. where filename is the name of the transmitted file
  93. with the file contents as standard input.
  94.  
  95. Each file transfer is acknowledged when COMMAND exits with 0 status.
  96. A non zero exit status terminates transfers.
  97.  
  98. A typical use for this form is
  99. .I rzrmail
  100. which calls rmail(1)
  101. to post mail to the user specified by the transmitted file name.
  102. For example, sending the file "caf" from a PC-DOS system to
  103. .I rzrmail
  104. on a
  105. .SM Unix
  106. system
  107. would result in the contents of the DOS file "caf" being mailed to user "caf".
  108.  
  109. On some
  110. .SM Unix
  111. systems, the login directory must contain a link to
  112. COMMAND as login sets SHELL=rsh which disallows absolute
  113. pathnames.
  114. If invoked with a leading ``v'',
  115. .I rz
  116. will report progress to /tmp/rzlog.
  117. The following entry works for
  118. .SM Unix
  119. 3.0:
  120. .ce
  121. rzrmail::5:1::/bin:/usr/local/rzrmail
  122. If the SHELL environment variable includes
  123. .I "rsh"
  124. or
  125. .I "rksh"
  126. (restricted shell),
  127. rz will not accept absolute pathnames
  128. or references to a parent directory,
  129. will not modify an existing file, and
  130. removes any files received in error.
  131.  
  132. If
  133. .B rz
  134. is invoked with stdout and stderr to different datasets,
  135. Verbose is set to 2, causing frame by frame progress reports
  136. to stderr.
  137. This may be disabled with the
  138. .B q
  139. option.
  140.  
  141. .PP
  142. The meanings of the available options are:
  143. .PP
  144. .PD 0
  145. .TP
  146. .B 1
  147. Use file descriptor 1 for ioctls and reads (Unix only).
  148. By default, file descriptor 0 is used.
  149. This option allows
  150. .I rz
  151. to be used with the
  152. .I cu
  153. ~$
  154. command.
  155. If the calling program has spawned a separate process to
  156. read characters from the modem,
  157. that process 
  158. must be disabled for
  159. .I rz
  160. to operate properly.
  161. .TP
  162. .B a
  163. Convert files to
  164. .SM Unix
  165. conventions by stripping carriage returns and all characters
  166. beginning with the first Control Z (CP/M end of file).
  167. .TP
  168. .B b
  169. Binary
  170. (tell it like it is)
  171. file transfer override.
  172. .TP
  173. .B c
  174. Request 16 bit CRC.
  175. XMODEM file transfers default to 8 bit checksum.
  176. YMODEM and ZMODEM normally use 16 bit CRC.
  177. .TP
  178. .B D
  179. Output file data to /dev/null; for testing.
  180. .TP
  181. .B p
  182. (ZMODEM) Protect: skip file if destination file exists.
  183. .TP
  184. .B q
  185. Quiet suppresses verbosity.
  186. .TP
  187. .B "t tim"
  188. Change timeout to
  189. .I tim
  190. tenths of seconds.
  191. .TP
  192. .B v
  193. Verbose
  194. causes a list of file
  195. names to be appended to
  196. /tmp/rzlog .
  197. More v's generate more output.
  198. .PD
  199. .ne 6
  200. .SH EXAMPLES
  201. .RE
  202. (Pro-YAM command)
  203. .RS
  204. .I <ALT-2>
  205. .br
  206. Pro-YAM Command:
  207. .I "sz *.h *.c"
  208. .br
  209. (This automatically invokes
  210. .I rz
  211. on the connected system.)
  212. .RE
  213. .SH SEE ALSO
  214. ZMODEM.DOC,
  215. YMODEM.DOC,
  216. IMP(CP/M),
  217. cu(1),
  218. Professional-YAM manual,
  219. sz(omen),
  220. usq(omen),
  221. undos(omen)
  222.  
  223. Compile time options required
  224. for various operating systems are described in the
  225. source file.
  226. .SH NOTES
  227. The Unix "ulimit" parameter must be set high enough
  228. to permit large file transfers.
  229.  
  230. The TTY input buffering on some systems may not allow long blocks
  231. or streaming input, especially at high baud rates.
  232. The Pro-YAM
  233. .B "zmodem l"
  234. numeric parameter may be set to a value between 64 and 1024 to limit the
  235. burst length ("zmodem pl100").
  236.  
  237. 32 bit CRC code courtesy Gary S. Brown.
  238. .SH BUGS
  239. Pathnames are restricted to 127 characters.
  240. In XMODEM single file mode, the pathname given on the command line
  241. is still processed as described above.
  242. The ASCII option\'s CR/LF to NL translation merely deletes CR\'s;
  243. undos(omen) performs a more intelligent translation.
  244.  
  245. Some versions of Unix cu(1) do not operate properly with this program.
  246. .SH "VMS VERSION"
  247. Some of the #includes with file names enclosed with angle brackets <>
  248. may need to have the angle brackets changed to "", or vice versa.
  249.  
  250. The VMS version does not set binary mode according to the incoming
  251. file type.
  252. Non binary file processing consists of stripping all characters beginning
  253. with CPMEOF (^Z).
  254.  
  255. The VMS version does not set the file time.
  256.  
  257. At high speeds,
  258. VMS sometimes loses incoming characters, resulting in retries
  259. and degradation of throughput.
  260.  
  261. The mysterious
  262. VMS C Standard I/O Package and RMS may interact to modify
  263. file contents unexpectedly.
  264.  
  265. The VMS version does not support invocation as
  266. .B rzCOMMAND .
  267. ZMODEM has not yet been implemented on the VMS version.
  268. .SH "ZMODEM CAPABILITIES"
  269. .I Rz
  270. supports incoming ZMODEM binary (-b), ASCII (-a),
  271. protect (-p),
  272. and append (-+)
  273. requests, and ZMODEM command execution.
  274. .SH FILES
  275. rz.c, rbsb.c, zm.c, zmodem.h source files.
  276.  
  277. /tmp/rzlog stores debugging output generated with -vv option.
  278.